<html>
  <head>
    <title>Carabiner Readme</title>
  </head>
  <body>
    <img alt="Carabiner Graphical Testing Framework" src="artifacts/art/title.bmp" />

    <h2>The Carabiner Mission Statement</h2>

      <h3>Whereas...</h3>
    	<ul>
      	  <li>Automated acceptance testing is a useful and worthy practice;</li>
          <li>Writing reliable automated tests for graphical components is difficult and time consuming;</li>
          <li>Graphical component correctness will always depend on asthetic properties and is therefore inherently subjective.</li>
      	</ul>
      It is therefore proposed that the best way to automatically test graphical
      components is, in fact, not to test them automatically, but to simplify the process of
      testing them manually.<p />

    <h3>To This End...</h3>

      We have developed the <a href="https://sourceforge.net/projects/carabiner/">Carabiner</a> framework.
      Carabiner is a collection of tools and utilities that designed to make testing graphical 
      components easier.<p />

      Sincerely,<br />
      The Carabiner Team

    <h2>Overview</h2>

     <p>Carabiner is a Java framework designed to work with existing technologies
     to make Graphical testing easier, safer, and faster. Carabiner facilitates the creation
     of small applications called 'test harnesses' that allow developers to quickly
     interact with Graphical controls and test them independently. It provides tools to
     automatically find common Graphical design mistakes. Carabiner uses a blessed/cursed
     metaphor to allow the developer to mark controls as either correct or incorrect.
     It will automatically detect if blessed controls change, notifying you
     that they must be re-checked.</p>

     <h2>Features</h2>

     <ul>
       <li><i>Graphical Inspector</i> looks for common design faults and warns you about them.</li>
       <li>Works with any automated testing framework.</li>
       <li>Works with hand-written or GUI builder generated controls.</li>
     </ul>

     <h2>Build and Usage</h2>

     <p>Carabiner is currently compilied with <a href="http://ant.apache.org/">Ant 1.6.2</a> and
       JDK 1.4.2_10. Other versions of Ant may work. Other versions of the JDK (probably) will not.
     Simply run <code>ant</code> from the base directory and it should generate a jar file.
     Include this jar file in your project class path and you're ready to use Carabiner!
     See the <a href="examples/index.html">examples</a> page for more help on using Carabiner.</p>

     <h2>Related Links</h2>
     <ul>
       <li><a href="publish/doc/index.html">JavaDoc</a> (You must run "ant javadoc" to generate the docs)</li>
       <li><a href="http://sourceforge.net/projects/carabiner">Sourceforge Project Page</a></li>
       <li><a href="http://code.google.com/p/carabiner">Google Code Project Page</a></li>
     </ul>

  </body>
</html>
